Instead of making changes outside of OneStream or then having to continuously copy and paste into the application, you can add formatted text using the Allow Rich Text property in the Text Box component. This allows you to create formatted text using the formatting toolbar in OneStream in the Text Box Dashboard component.
Allow Rich Text
This property allows you to format font, color, alignment and more using rich text. The property is located in the Text Box component properties and has a default value of False.
-
When set to False, this defaults to plain text and the component will not contain formatting options.
-
When set to True, this allows you to add rich text formatting to your content.
NOTE: When set to True, the Multiline field will not be enabled if Allow Rich Text is set to True.
Enable Spell Check
When Allow Rich Text is set to True, this property displays the spell check options in the toolbar. When Allow Rich Text is set to False, this property is disabled. As an Implementer in the Windows Application, you can set the Enable Spell Check field in the text box component to True or False. This property is under the Text Box Component > Component Properties > Text Box section.
NOTE: This field property cannot be updated through Parameters or Business Rules.
When Enable Spell Check is set to True, these spell check icons are available in the Text Box ribbon:
- Proofing: Spelling and Language
-
Spell Check: English (United States)
The default for Spell Check is English. Spell Check will only work when English is selected in Windows for International users. When set to Not Used, misspelled words will not display red lines underneath the text.
IMPORTANT: Existing Text Box components will have Spell Check disabled and the default will be set to False.
IsReadOnly
As an Implementer in the Windows Application, you can set the rich text functionality in the text box component to be read-only or editable for select users through the IsReadOnly property.
This property is located in the Text Box Dashboard Component > Component Properties > Display Format field's Edit button > Display Format dialog > General section > Position section. You can also type "IsReadOnly=" to equal either True or False in the Display Format field. The default value is (Use Default). This property affects existing text boxes and rich text boxes.
-
When set to True, you cannot edit the Text Box content and this property is read-only.
-
When set to False or (Use Default), you can edit the Text Box content.
Set IsReadOnly Property
As an Implementer in the Windows Application, you can use a Business Rule or Custom Parameters to set the IsReadOnly parameter to True or False.
Here are a few scenarios to set this property:
Scenario 1
You can set a Dashboard String Business Rule in a Workspace Assembly with the IsReadOnly property. You can set the IsReadOnly property using Workspace Assemblies by creating a Dashboard String Function Business Rule which returns "IsReadOnly = True" or "IsReadOnly = False". This will not be automatically added to the Assembly File code.
For example, in the Rich Text Component > Display Format field, type the following string: XFBR(Workspace.Current.MyAssembly.MyStrings, IsReadOnly).
In the Workspace Assembly > Assembly File service, update the XFBR string to return either "IsReadOnly = True" or "IsReadOnly = False"” inside the Assembly File service. Refresh your dashboard after updating the XFBR string to display the updated state. If IsReadOnly is set to False, users can edit.
Scenario 2
You can reference a Custom Parameter in the Text Box Component > Display Format field. For example, if the Custom Parameter was named "TextBoxReadOnly", enter "|!TextBoxReadOnly!|" in the Text Box Component > Display Format field. Then in the Custom Parameter, write "IsReadOnly = True". If the Text Box Component > Display Format does not reference IsReadOnly, but the Display Format field references the Custom Parameter, which contains IsReadOnly = True, the Dashboard Text Box would be IsReadOnly and users will not be able to edit.
Scenario 3
You can set a Dashboard XFBR String Business Rule with the IsReadOnly property. You can set the IsReadOnly property using Business Rules by creating a Dashboard XFBR String Function Business Rule which returns "IsReadOnly = True" or "IsReadOnly = False". This will not be automatically added to the args line of code.
In a Dashboard XFBR String Business Rule, update the XFBR string to return either "IsReadOnly = True" or "IsReadOnly = False" inside the args lines of code. Refresh your dashboard after updating the XFBR string to display the updated state. If IsReadOnly is set to False, users can edit.
